Kotlin Multiplatform Client for Docker/dev.limebeck.libs.docker.client.model

Package-level declarations

Types

data class ContainerLogsParameters(val follow: Boolean = false, val stdout: Boolean = true, val stderr: Boolean = true, val timestamps: Boolean = false, val tail: String? = null, val since: Long? = null, val until: Long? = null)

Selects output and history for dev.limebeck.libs.docker.client.api.Containers.getLogs. The default reads available stdout/stderr history and finishes; set follow for live output.

DockerApiException

class DockerApiException(val status: HttpStatusCode, val error: ErrorResponse) : IllegalStateException

An HTTP error returned when collecting a cold Docker stream. error retains raw daemon details and may contain sensitive data; the exception message includes only status. SDK stream failures also expose safe operation metadata via the diagnostics dockerContext extension.

ExecSession

class ExecSession : AutoCloseable

Owned duplex exec/attach connection, independent of the client's HTTP connection pool.

ImageProgress

@Serializable

data class ImageProgress<out TAux>(val id: String? = null, val status: String? = null, val stream: String? = null, val progress: String? = null, val progressDetail: ImageProgressDetail? = null, val aux: TAux? = null)

One Docker image-operation record. Fields may be absent. TAux is selected by the operation: ImagePushResult for push, Unit for create/load. Counts describe the individual layer id, not overall operation completion. The operation's returned Result determines success, never a status string or percentage.

ImageProgressDetail

@Serializable

data class ImageProgressDetail(val current: ULong? = null, val total: ULong? = null)

Exact per-layer counts. Missing counts are unknown; a zero total is not a usable denominator.

ImagePushResult

@Serializable

data class ImagePushResult(val tag: String? = null, val digest: String? = null, val size: ULong? = null)

Optional manifest information supplied in Docker push progress.

LogLine

data class LogLine(val type: LogLine.Type, val line: String)

OutputChunk

class OutputChunk(val type: LogLine.Type, val bytes: ByteArray)

A binary output fragment. Boundaries need not coincide with lines or UTF-8 characters.

Result

@JvmInline

value class Result<out T, out E>(unboxed: Any?)

Success value T or typed error E, distinct from kotlin.Result.

SwarmCreateResponse

@Serializable

data class SwarmCreateResponse(val id: String)

ID returned by Swarm secret/config creation (Docker uses the uppercase JSON key ID).

SwarmLogsParameters

data class SwarmLogsParameters(val follow: Boolean = false, val stdout: Boolean = true, val stderr: Boolean = true, val timestamps: Boolean = false, val details: Boolean = false, val since: Long? = null, val tail: String? = null)

Service/task log options. History is read once by default; follow keeps the request open. since is Unix seconds; tail is a decimal line count or "all" (null uses Docker's default). details includes context supplied by Docker. TTY merges stdout and stderr.

Functions

asError

fun <E> E.asError(): Result<Nothing, E>

asSuccess

fun <T> T.asSuccess(): Result<T, Nothing>